-
Notifications
You must be signed in to change notification settings - Fork 51
SphinxDocs set up #572
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
SphinxDocs set up #572
Conversation
Doc build 1
Update to add examples, update the index landing page and add a getting started
@@ -0,0 +1,52 @@ | |||
name: Docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add .DS_Store to .gitignore, and any sphinx related build files, like _build/ build/?
@@ -0,0 +1,98 @@ | |||
import os |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain why this script is needed?
I think you can do a much simpler setup for sphinx gallery and specify those in the conf.py. https://sphinx-gallery.github.io/stable/configuration.html
|
||
Here are some suggested steps to get started with Monarch: | ||
|
||
1. **Installation**: Install Monarch using pip: `pip install torchmonarch-nightly` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Getting started has more detail on installation, so may just start with that and skip #1.
run: | | ||
set -eux | ||
|
||
pip install -r docs/requirements.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to install requirements.txt from the root of the repo.
and then build monarch from source: pip install --no-build-isolation .
sphinxcontrib-mermaid==1.0.0 | ||
myst-parser #==0.18.1 # if want to contribute in markdown | ||
sphinx-gallery==0.14.0 # only if hosting interactive tutorials | ||
sphinx-sitemap==2.7.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add sphinx-rust== figure out the version
Creating a sphinx site for the monarch docs
Example mock ups:

